Diese Seite basiert auf der unten angezeigten Überblicksthemenvorlage – verwenden Sie diese Vorlage, um ähnliche Themen zu erstellen.
Dieser Leitfaden wird von der Abteilung der technischen Redaktion verfasst und gepflegt, wobei auch Rückmeldungen von anderen Mitarbeitern des Unternehmens berücksichtigt werden. Ziel des Leitfadens ist in erster Linie, Dokumentationsvorgaben für die externe Dokumentation von MyCompany (Benutzerhandbücher, Online-Hilfe, Web-Inhalte) festzulegen. Darüber hinaus soll es Mitarbeitern des Unternehmens ermöglicht werden, der Abteilung der technischen Redaktion Informationen auf die richtige Art und Weise zu übermitteln.
Dieser Leitfaden richtet sich an alle, die nach stilistischen Vorgaben für MyCompany suchen, also etwa Software-Entwickler, Mitarbeiter der Qualitätssicherung, unabhängige Vertragspartner und die Abteilungen für Marketing und Schulungen.
Überblicksthemen dienen zur Einführung oder Beschreibung allgemeiner Konzepte. Hier wird das "große Ganze" präsentiert. Beispielsweise sind Begrüßungsthemen, die Benutzern eine erste Orientierung hinsichtlich Ihrer Richtlinien und Verfahrensweisen, Online-Handbücher, Abteilungsrichtlinien oder spezifischer Komponenten verschaffen, Überblicksthemen. Sie werden üblicherweise am Anfang eines Abschnitts oder einer Einheit angezeigt. Überblicksthemen können auch eine Erklärung der darauf folgenden Informationen beinhalten oder die Nutzung der Informationen erläutern. Weitere Inhalte sind Sicherheitswarnungen und Vorsichtsmaßnahmen und empfohlene Ressourcen. Überblicksthemen bieten oft Informationen, die über die in den ersten Abschnitten von Entscheidungs-/Navigationsthemen aufgeführten hinausgehen. Tatsächlich ist es durchaus üblich, ein Überblicksthema bereitzustellen, das mit einem Entscheidungs-/Navigationsthema verknüpft ist, welches wiederum Verknüpfungen zu Aufgabenthemen beinhaltet. Über diese Struktur wird der Benutzer von allgemeinen zu spezifischeren Informationen geleitet.
Geben Sie in diesem Bereich den Inhalt Ihres Überblicksthemas ein.